<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Secure Sockets: cy_tls_params_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="cypress_logo.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Secure Sockets</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('structcy__tls__params__t.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle"><div class="title">cy_tls_params_t Struct Reference<div class="ingroups"><a class="el" href="group__group__cy__tls.html">TLS API</a> &raquo; <a class="el" href="group__group__cy__tls__structures.html">Structures</a></div></div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<div class="textblock"><p >Parameter structure for initializing the TLS interface. </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a4ae05e94ea7a28a935cd4eeb0fe1533a"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__tls__params__t.html#a4ae05e94ea7a28a935cd4eeb0fe1533a">rootca_certificate</a></td></tr>
<tr class="memdesc:a4ae05e94ea7a28a935cd4eeb0fe1533a"><td class="mdescLeft">&#160;</td><td class="mdescRight">RootCA certificate in PEM format.  <a href="structcy__tls__params__t.html#a4ae05e94ea7a28a935cd4eeb0fe1533a">More...</a><br /></td></tr>
<tr class="separator:a4ae05e94ea7a28a935cd4eeb0fe1533a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35aad84ed2472dd02d19b4af83ea4545"><td class="memItemLeft" align="right" valign="top"><a id="a35aad84ed2472dd02d19b4af83ea4545" name="a35aad84ed2472dd02d19b4af83ea4545"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>rootca_certificate_length</b></td></tr>
<tr class="memdesc:a35aad84ed2472dd02d19b4af83ea4545"><td class="mdescLeft">&#160;</td><td class="mdescRight">RootCA certificate length, excluding the 'null' terminator. <br /></td></tr>
<tr class="separator:a35aad84ed2472dd02d19b4af83ea4545"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a573b570a103f6ebc9c9bf4d5a6e1d323"><td class="memItemLeft" align="right" valign="top"><a id="a573b570a103f6ebc9c9bf4d5a6e1d323" name="a573b570a103f6ebc9c9bf4d5a6e1d323"></a>
const void *&#160;</td><td class="memItemRight" valign="bottom"><b>tls_identity</b></td></tr>
<tr class="memdesc:a573b570a103f6ebc9c9bf4d5a6e1d323"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to memory containing the certificate and private key in the underlying TLS stack format. <br /></td></tr>
<tr class="separator:a573b570a103f6ebc9c9bf4d5a6e1d323"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06955dbf1136ae556cca7c39d0356274"><td class="memItemLeft" align="right" valign="top"><a id="a06955dbf1136ae556cca7c39d0356274" name="a06955dbf1136ae556cca7c39d0356274"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>auth_mode</b></td></tr>
<tr class="memdesc:a06955dbf1136ae556cca7c39d0356274"><td class="mdescLeft">&#160;</td><td class="mdescRight">TLS authentication mode. <br /></td></tr>
<tr class="separator:a06955dbf1136ae556cca7c39d0356274"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4149ff366e964d2cd1796b8738ecb018"><td class="memItemLeft" align="right" valign="top"><a id="a4149ff366e964d2cd1796b8738ecb018" name="a4149ff366e964d2cd1796b8738ecb018"></a>
unsigned char&#160;</td><td class="memItemRight" valign="bottom"><b>mfl_code</b></td></tr>
<tr class="memdesc:a4149ff366e964d2cd1796b8738ecb018"><td class="mdescLeft">&#160;</td><td class="mdescRight">TLS max fragment length code. <br /></td></tr>
<tr class="separator:a4149ff366e964d2cd1796b8738ecb018"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0ee444760cdf55cbfbaf9f8e483b0b2"><td class="memItemLeft" align="right" valign="top"><a id="ad0ee444760cdf55cbfbaf9f8e483b0b2" name="ad0ee444760cdf55cbfbaf9f8e483b0b2"></a>
const char **&#160;</td><td class="memItemRight" valign="bottom"><b>alpn_list</b></td></tr>
<tr class="memdesc:ad0ee444760cdf55cbfbaf9f8e483b0b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Application-Layer Protocol Negotiation (ALPN) protocol list to be passed in TLS ALPN extension. <br /></td></tr>
<tr class="separator:ad0ee444760cdf55cbfbaf9f8e483b0b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1523b9b71441c583189b5afbff957765"><td class="memItemLeft" align="right" valign="top"><a id="a1523b9b71441c583189b5afbff957765" name="a1523b9b71441c583189b5afbff957765"></a>
char *&#160;</td><td class="memItemRight" valign="bottom"><b>hostname</b></td></tr>
<tr class="memdesc:a1523b9b71441c583189b5afbff957765"><td class="mdescLeft">&#160;</td><td class="mdescRight">Server hostname used with the Server Name Indication (SNI) extension. <br /></td></tr>
<tr class="separator:a1523b9b71441c583189b5afbff957765"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab16d06b1abafbf35079bd7f878a2f690"><td class="memItemLeft" align="right" valign="top"><a id="ab16d06b1abafbf35079bd7f878a2f690" name="ab16d06b1abafbf35079bd7f878a2f690"></a>
<a class="el" href="group__group__cy__tls__typedefs.html#ga10fc7493040524d0e1f0f8c12435304c">cy_network_recv_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>network_recv</b></td></tr>
<tr class="memdesc:ab16d06b1abafbf35079bd7f878a2f690"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to a caller-defined network receive function. <br /></td></tr>
<tr class="separator:ab16d06b1abafbf35079bd7f878a2f690"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6dcd4ebeb549d85ae5f6db175ec3ca9f"><td class="memItemLeft" align="right" valign="top"><a id="a6dcd4ebeb549d85ae5f6db175ec3ca9f" name="a6dcd4ebeb549d85ae5f6db175ec3ca9f"></a>
<a class="el" href="group__group__cy__tls__typedefs.html#ga4deb60051b4e0097cef5e7be77ade9f0">cy_network_send_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>network_send</b></td></tr>
<tr class="memdesc:a6dcd4ebeb549d85ae5f6db175ec3ca9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to a caller-defined network send function. <br /></td></tr>
<tr class="separator:a6dcd4ebeb549d85ae5f6db175ec3ca9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cc35defe25819af0a6a419a50b723d0"><td class="memItemLeft" align="right" valign="top"><a id="a9cc35defe25819af0a6a419a50b723d0" name="a9cc35defe25819af0a6a419a50b723d0"></a>
void *&#160;</td><td class="memItemRight" valign="bottom"><b>context</b></td></tr>
<tr class="memdesc:a9cc35defe25819af0a6a419a50b723d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">User context. <br /></td></tr>
<tr class="separator:a9cc35defe25819af0a6a419a50b723d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade53309452d299835a58e2cf902070da"><td class="memItemLeft" align="right" valign="top"><a id="ade53309452d299835a58e2cf902070da" name="ade53309452d299835a58e2cf902070da"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>load_rootca_from_ram</b></td></tr>
<tr class="memdesc:ade53309452d299835a58e2cf902070da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flag for setting the RootCA certificate location. <br /></td></tr>
<tr class="separator:ade53309452d299835a58e2cf902070da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a759f4bf95e9e1c89ca547a9d1a68b353"><td class="memItemLeft" align="right" valign="top"><a id="a759f4bf95e9e1c89ca547a9d1a68b353" name="a759f4bf95e9e1c89ca547a9d1a68b353"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>load_device_cert_key_from_ram</b></td></tr>
<tr class="memdesc:a759f4bf95e9e1c89ca547a9d1a68b353"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flag for setting the device cert &amp; key location. <br /></td></tr>
<tr class="separator:a759f4bf95e9e1c89ca547a9d1a68b353"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a id="a4ae05e94ea7a28a935cd4eeb0fe1533a" name="a4ae05e94ea7a28a935cd4eeb0fe1533a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ae05e94ea7a28a935cd4eeb0fe1533a">&#9670;&nbsp;</a></span>rootca_certificate</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* cy_tls_params_t::rootca_certificate</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>RootCA certificate in PEM format. </p>
<p >It should be a 'null'-terminated string. </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>Secure Sockets</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
</body>
</html>
